Interface output

The output interface for the execute method of tools

It is is used to communicate the results of tool execution to Nova and also provides access to the presentation interface for showing graphics in the Viewer, and the log interface for displaying status messages in the panel for a tool.

See also input — for accessing the input to tools.

output:add(name, value)
Arguments:

  • name (string)

  • value (any)

Set the value of a tool result.

The name argument should match the name of the result in the Result definition, and the value should be of the corresponding type.

output:getPresentation()
Return type:

presentation

Returns the presentation interface for showing overlays or regions in the viewer.

output:setTransform2D(transform)
Argument:

Set a 2D transform that will be passed to any child tools.

output:setTransform3D(transform)
Argument:

Set a 3D transform that will be passed to any child tools.

The Transform must be a 3D transform of type 'IDENTITY', 'TRANSLATION' or 'RIGID'.